/*
 * Copyright (c) 2012 copyright Gábor Heizer
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
 * is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package hu.my.bnf;

import hu.my.bnf.validation.StringValidation;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.Serializable;

/**
 * This is the base class in BNF package.
 */
abstract class AbstractBNF implements BNF, Serializable {

//--------------------------------------------------------------------------------------------------------------------------------
// Fields
//--------------------------------------------------------------------------------------------------------------------------------

    /**
     * Text of the <code>comment</code>.
     */
    private String comment = "";

    /**
     * The name of a non-terminal symbol.
     */
    private final String metaIdentifier;

    /**
     * URN.
     */
    private final String urn;

//--------------------------------------------------------------------------------------------------------------------------------
// Constructors
//--------------------------------------------------------------------------------------------------------------------------------

    /**
     * Constructor.
     *
     * @param urn            URN.
     * @param metaIdentifier Meta-Identifier.
     */
    AbstractBNF(@NotNull final String urn, @NotNull final String metaIdentifier) {
        this.urn = urn;
        this.metaIdentifier = metaIdentifier;

        if (StringValidation.isEmpty(this.urn) || StringValidation.isEmpty(this.metaIdentifier)) {
            throw new IllegalArgumentException("Urn or metaIdentifier argument not specified");
        }
    }

//--------------------------------------------------------------------------------------------------------------------------------
// Properties
//--------------------------------------------------------------------------------------------------------------------------------

    /**
     * Get the comment associated with this BNF.
     *
     * @return String Text <code>String</code> text for comment.
     */
    @NotNull
    public final String getComment() {
        return comment;
    }

    /**
     * This will set the value of the comment.
     *
     * @param comment Text <code>String</code> content of comment.
     */
    public final void setComment(@Nullable final String comment) {
        this.comment = StringValidation.getValidString(comment);
    }

    /**
     * Return the MetaIdentifier of this BNF.
     *
     * @return The URN of this MetaIdentifier.
     */
    @NotNull
    public final String getMetaIdentifier() {
        return metaIdentifier;
    }

    /**
     * The toString method for AbstractBNF Object returns a string consisting of:
     * metaIdentifier, urn, comment.
     *
     * @return a string representation of the object.
     */
    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder();
        sb.append("urn='").append(urn).append('\'');
        sb.append(", metaIdentifier='").append(metaIdentifier).append('\'');
        sb.append(", comment='").append(comment).append('\'');
        return sb.toString();
    }

    /**
     * Return the URN of this BNF.
     *
     * @return The URN of this BNF.
     */
    @NotNull
    public final String getUrn() {
        return urn;
    }
}
